docs(tool-executions): say why this page calls two different hosts - #1159
Closed
josebarrueta wants to merge 1 commit into
Closed
docs(tool-executions): say why this page calls two different hosts#1159josebarrueta wants to merge 1 commit into
josebarrueta wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
josebarrueta
force-pushed
the
plt-3107-logging-policy-rename
branch
from
August 28, 2026 20:13
7fba734 to
18b2a17
Compare
josebarrueta
force-pushed
the
plt-3107-two-host-note
branch
from
August 28, 2026 20:13
8b2e3eb to
85c8dd7
Compare
Base automatically changed from
plt-3107-logging-policy-rename
to
add-doc-screenshots
August 28, 2026 20:18
The page reads history from one host and writes policy to another, thirty lines apart, with nothing saying why. Both are right — history is served by the Engine, the organization's settings by the control plane — but a reader who notices the difference has no way to tell it from a typo, and guessing wrong costs them a 404 on a path that looks correct. Named once, where the first host appears, with the path prefixes attached because they differ together. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
josebarrueta
force-pushed
the
plt-3107-two-host-note
branch
from
August 28, 2026 20:20
85c8dd7 to
224846d
Compare
Contributor
Author
|
Withdrawing — not needed. @evantahler no action for you here; you can ignore the two questions I left above. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
One sentence, split out from #1157 so it can be rejected on its own — it is a judgement call about how the docs explain Arcade's API surface, not a correction like the rest of that PR.
Stacked on #1157 →
add-doc-screenshots→main.Why
After #1157 the page is correct but reads oddly. It says the base URL is
https://api.arcade.dev, and thirty lines later callshttps://cloud.arcade.dev. Both are right:tool_executions(read history)api.arcade.dev/v1/...logging-config(change policy)cloud.arcade.dev/api/v1/...Verified against the harness clients, which are the source of truth for these paths —
engine.tsbuildsv1/orgs/{org}/projects/{proj},coordinator.tsbuildsapi/v1/orgs/{org}.A reader who notices the difference cannot tell it from a typo, and guessing wrong costs a 404 on a path that looks right. That is not hypothetical: I made exactly this mistake writing #1141, applying the Engine's convention to a control-plane endpoint. It shipped and stood until this week.
What it says
@evantahler — worth your call on two things:
CI note
Generate LLMs.txtfails here, as it does on every PR in this repo since 2026-08-26 — it dies at checkout becausesecrets.DOCS_PUBLISHABLE_GH_TOKENresolves empty. Unrelated to this change.Note
Low Risk
Documentation-only clarification with no runtime or API behavior changes.
Overview
Adds a short note in Read executions from the API so readers are not surprised when the same page uses
https://api.arcade.devfor execution history and laterhttps://cloud.arcade.devfor logging policy.The new copy states that listing/reading tool runs is on the Engine (
/v1/...), while org recording and retention settings (and the linked audit log API) live on the control plane (/api/v1/...), and that host and path prefix change together.Reviewed by Cursor Bugbot for commit 224846d. Bugbot is set up for automated code reviews on this repo. Configure here.